<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ConfigurationModule xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/com/rocoto/configuration/ConfigurationModule.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> *    Copyright 2009-2010 The Rocoto Team</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> *    Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *    you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> *    You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *       <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *    Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *    distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> *    See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> *    limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> com.rocoto.configuration;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> java.io.Closeable;
<a name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> java.io.File;
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.io.IOException;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.io.InputStreamReader;
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> java.io.Reader;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> java.net.HttpURLConnection;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> java.net.MalformedURLException;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> java.net.URL;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> java.net.URLConnection;
<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> java.nio.charset.Charset;
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a name="30" href="#30">30</a>  
<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.configuration.CompositeConfiguration;
<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.configuration.Configuration;
<a name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.configuration.FileConfiguration;
<a name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.Log;
<a name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.LogFactory;
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>  <strong class="jxr_keyword">import</strong> com.google.inject.AbstractModule;
<a name="38" href="#38">38</a>  <strong class="jxr_keyword">import</strong> com.google.inject.name.Names;
<a name="39" href="#39">39</a>  
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment">/**</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * Easy-to-use {@code Apache commons-configurations} wrapper,</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * built for users that require binding more complex configuration format.</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> *</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * @author Simone Tripodi</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * @version $Id: ConfigurationModule.java 174 2010-01-03 13:33:17Z simone.tripodi $</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> */</em>
<a name="47" href="#47">47</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../com/rocoto/configuration/ConfigurationModule.html">ConfigurationModule</a> <strong class="jxr_keyword">extends</strong> AbstractModule {
<a name="48" href="#48">48</a>  
<a name="49" href="#49">49</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Log log = LogFactory.getLog(<strong class="jxr_keyword">this</strong>.getClass());
<a name="50" href="#50">50</a>  
<a name="51" href="#51">51</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Charset UTF_8 = Charset.forName(<span class="jxr_string">"UTF-8"</span>);
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> CompositeConfiguration configuration = <strong class="jxr_keyword">new</strong> CompositeConfiguration();
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>      <em class="jxr_javadoccomment">/**</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     * This class loader.</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     */</em>
<a name="58" href="#58">58</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ClassLoader defaultClassLoader = <strong class="jxr_keyword">this</strong>.getClass().getClassLoader();
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addConfiguration(Configuration configuration) {
<a name="61" href="#61">61</a>          <strong class="jxr_keyword">this</strong>.configuration.addConfiguration(configuration);
<a name="62" href="#62">62</a>      }
<a name="63" href="#63">63</a>  
<a name="64" href="#64">64</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> loadConfiguration(Class&lt;? <strong class="jxr_keyword">extends</strong> FileConfiguration&gt; configurationType, String classpathResource) {
<a name="65" href="#65">65</a>          <strong class="jxr_keyword">this</strong>.loadConfiguration(configurationType, classpathResource, UTF_8);
<a name="66" href="#66">66</a>      }
<a name="67" href="#67">67</a>  
<a name="68" href="#68">68</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> loadConfiguration(Class&lt;? <strong class="jxr_keyword">extends</strong> FileConfiguration&gt; configurationType,
<a name="69" href="#69">69</a>              String classpathResource,
<a name="70" href="#70">70</a>              Charset encoding) {
<a name="71" href="#71">71</a>          <strong class="jxr_keyword">this</strong>.loadConfiguration(configurationType, classpathResource, <strong class="jxr_keyword">this</strong>.defaultClassLoader, encoding);
<a name="72" href="#72">72</a>      }
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> loadConfiguration(Class&lt;? <strong class="jxr_keyword">extends</strong> FileConfiguration&gt; configurationType,
<a name="75" href="#75">75</a>              String classpathResource,
<a name="76" href="#76">76</a>              ClassLoader classLoader) {
<a name="77" href="#77">77</a>          <strong class="jxr_keyword">this</strong>.loadConfiguration(configurationType,
<a name="78" href="#78">78</a>                  classpathResource,
<a name="79" href="#79">79</a>                  classLoader,
<a name="80" href="#80">80</a>                  UTF_8);
<a name="81" href="#81">81</a>      }
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> loadConfiguration(Class&lt;? <strong class="jxr_keyword">extends</strong> FileConfiguration&gt; configurationType,
<a name="84" href="#84">84</a>              String classpathResource,
<a name="85" href="#85">85</a>              ClassLoader classLoader,
<a name="86" href="#86">86</a>              Charset encoding) {
<a name="87" href="#87">87</a>          <strong class="jxr_keyword">if</strong> (classpathResource == <strong class="jxr_keyword">null</strong>) {
<a name="88" href="#88">88</a>              <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"'classpathConfigurationUrl' argument can't be null"</span>);
<a name="89" href="#89">89</a>          }
<a name="90" href="#90">90</a>          <strong class="jxr_keyword">if</strong> (classLoader == <strong class="jxr_keyword">null</strong>) {
<a name="91" href="#91">91</a>              <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"'classLoader' argument can't be null"</span>);
<a name="92" href="#92">92</a>          }
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>          <strong class="jxr_keyword">if</strong> ('/' == classpathResource.charAt(0)) {
<a name="95" href="#95">95</a>              classpathResource = classpathResource.substring(1);
<a name="96" href="#96">96</a>          }
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>          URL url = classLoader.getResource(classpathResource);
<a name="99" href="#99">99</a>          <strong class="jxr_keyword">if</strong> (url == <strong class="jxr_keyword">null</strong>) {
<a name="100" href="#100">100</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"classpathResource '"</span>
<a name="101" href="#101">101</a>                     + classpathResource
<a name="102" href="#102">102</a>                     + <span class="jxr_string">"' doesn't exist"</span>);
<a name="103" href="#103">103</a>         }
<a name="104" href="#104">104</a>         <strong class="jxr_keyword">this</strong>.loadConfiguration(configurationType, url, encoding);
<a name="105" href="#105">105</a>     }
<a name="106" href="#106">106</a> 
<a name="107" href="#107">107</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> loadConfiguration(Class&lt;? <strong class="jxr_keyword">extends</strong> FileConfiguration&gt; configurationType,
<a name="108" href="#108">108</a>             File configurationFile) {
<a name="109" href="#109">109</a>         <strong class="jxr_keyword">this</strong>.loadConfiguration(configurationType, configurationFile, UTF_8);
<a name="110" href="#110">110</a>     }
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> loadConfiguration(Class&lt;? <strong class="jxr_keyword">extends</strong> FileConfiguration&gt; configurationType,
<a name="113" href="#113">113</a>             File configurationFile,
<a name="114" href="#114">114</a>             Charset encoding) {
<a name="115" href="#115">115</a>         <strong class="jxr_keyword">if</strong> (configurationFile == <strong class="jxr_keyword">null</strong>) {
<a name="116" href="#116">116</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"'configurationFile' argument mustn't be null"</span>);
<a name="117" href="#117">117</a>         }
<a name="118" href="#118">118</a>         <strong class="jxr_keyword">if</strong> (!configurationFile.exists()) {
<a name="119" href="#119">119</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Configuration file '"</span>
<a name="120" href="#120">120</a>                     + configurationFile.getAbsolutePath()
<a name="121" href="#121">121</a>                     + <span class="jxr_string">"' doesn't exist"</span>);
<a name="122" href="#122">122</a>         }
<a name="123" href="#123">123</a>         <strong class="jxr_keyword">if</strong> (configurationFile.isDirectory()) {
<a name="124" href="#124">124</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Impossible to load Configuration file '"</span>
<a name="125" href="#125">125</a>                     + configurationFile.getAbsolutePath()
<a name="126" href="#126">126</a>                     + <span class="jxr_string">"' because it is a directory"</span>);
<a name="127" href="#127">127</a>         }
<a name="128" href="#128">128</a> 
<a name="129" href="#129">129</a>         <strong class="jxr_keyword">try</strong> {
<a name="130" href="#130">130</a>             <strong class="jxr_keyword">this</strong>.loadConfiguration(configurationType, configurationFile.toURL(), encoding);
<a name="131" href="#131">131</a>         } <strong class="jxr_keyword">catch</strong> (MalformedURLException e) {
<a name="132" href="#132">132</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(<span class="jxr_string">"Impossible to load configuration file '"</span>
<a name="133" href="#133">133</a>                     + configurationFile.getAbsolutePath()
<a name="134" href="#134">134</a>                     + <span class="jxr_string">", see nested exceptions"</span>, e);
<a name="135" href="#135">135</a>         }
<a name="136" href="#136">136</a>     }
<a name="137" href="#137">137</a> 
<a name="138" href="#138">138</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> loadConfiguration(Class&lt;? <strong class="jxr_keyword">extends</strong> FileConfiguration&gt; configurationType, URL url, Charset encoding) {
<a name="139" href="#139">139</a>         URLConnection connection = <strong class="jxr_keyword">null</strong>;
<a name="140" href="#140">140</a>         InputStream input = <strong class="jxr_keyword">null</strong>;
<a name="141" href="#141">141</a>         Reader reader = <strong class="jxr_keyword">null</strong>;
<a name="142" href="#142">142</a>         <strong class="jxr_keyword">try</strong> {
<a name="143" href="#143">143</a>             connection = url.openConnection();
<a name="144" href="#144">144</a>             input = connection.getInputStream();
<a name="145" href="#145">145</a>             reader = <strong class="jxr_keyword">new</strong> InputStreamReader(input, encoding);
<a name="146" href="#146">146</a> 
<a name="147" href="#147">147</a>             FileConfiguration configuration = configurationType.newInstance();
<a name="148" href="#148">148</a>             configuration.load(reader);
<a name="149" href="#149">149</a>             <strong class="jxr_keyword">this</strong>.configuration.addConfiguration(configuration);
<a name="150" href="#150">150</a>         } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="151" href="#151">151</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(<span class="jxr_string">"Impossible to open configuration URL "</span>
<a name="152" href="#152">152</a>                     + url
<a name="153" href="#153">153</a>                     + <span class="jxr_string">", see nested exceptions"</span>, e);
<a name="154" href="#154">154</a>         } <strong class="jxr_keyword">finally</strong> {
<a name="155" href="#155">155</a>             <strong class="jxr_keyword">if</strong> (connection != <strong class="jxr_keyword">null</strong> &amp;&amp; (connection instanceof HttpURLConnection)) {
<a name="156" href="#156">156</a>                 ((HttpURLConnection) connection).disconnect();
<a name="157" href="#157">157</a>             }
<a name="158" href="#158">158</a>             closeQuietly(input);
<a name="159" href="#159">159</a>             closeQuietly(reader);
<a name="160" href="#160">160</a>         }
<a name="161" href="#161">161</a>     }
<a name="162" href="#162">162</a> 
<a name="163" href="#163">163</a>     <em class="jxr_javadoccomment">/**</em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     * {@inheritDoc}</em>
<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">     */</em>
<a name="166" href="#166">166</a>     @Override
<a name="167" href="#167">167</a>     @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a name="168" href="#168">168</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> configure() {
<a name="169" href="#169">169</a>         Iterator&lt;String&gt; keys = <strong class="jxr_keyword">this</strong>.configuration.getKeys();
<a name="170" href="#170">170</a>         <strong class="jxr_keyword">while</strong> (keys.hasNext()) {
<a name="171" href="#171">171</a>             String key = keys.next();
<a name="172" href="#172">172</a>             String value = <strong class="jxr_keyword">this</strong>.configuration.getString(key);
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a>             <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.log.isDebugEnabled()) {
<a name="175" href="#175">175</a>                 <strong class="jxr_keyword">this</strong>.log.debug(<span class="jxr_string">"Binding property '"</span>
<a name="176" href="#176">176</a>                         + key
<a name="177" href="#177">177</a>                         + <span class="jxr_string">" = "</span>
<a name="178" href="#178">178</a>                         + value);
<a name="179" href="#179">179</a>             }
<a name="180" href="#180">180</a> 
<a name="181" href="#181">181</a>             <strong class="jxr_keyword">this</strong>.bindConstant().annotatedWith(Names.named(key)).to(value);
<a name="182" href="#182">182</a>         }
<a name="183" href="#183">183</a>     }
<a name="184" href="#184">184</a> 
<a name="185" href="#185">185</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> closeQuietly(Closeable closeable) {
<a name="186" href="#186">186</a>         <strong class="jxr_keyword">if</strong> (closeable != <strong class="jxr_keyword">null</strong>) {
<a name="187" href="#187">187</a>             <strong class="jxr_keyword">try</strong> {
<a name="188" href="#188">188</a>                 closeable.close();
<a name="189" href="#189">189</a>             } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a name="190" href="#190">190</a>             }
<a name="191" href="#191">191</a>         }
<a name="192" href="#192">192</a>     }
<a name="193" href="#193">193</a> 
<a name="194" href="#194">194</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

